home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 151-175 / scopedisk155 / qed / startup.txt < prev    next >
Text File  |  1995-03-19  |  13KB  |  302 lines
  1.                                    QED
  2.                                 Version 1.0
  3.  
  4.                               Preliminary Docs
  5.                                   9/16/90
  6.  
  7.                  Copyright 1988-1990 by Darren M. Greenwald
  8.                             All rights reserved
  9.  
  10. ======================================================================
  11.                                REQUIREMENTS
  12. ======================================================================
  13.  
  14. KICKSTART - 1.2 or higher
  15.  
  16. RAM - 256K RAM or more.
  17.  
  18. STACK USEAGE - A minimum stack size of 10000 bytes is required.
  19.  
  20.  
  21. ======================================================================
  22.                         MAKING A BACKUP COPY OF QED
  23. ======================================================================
  24.  
  25.  
  26.      The first thing you should do is make a backup copy of QED, and any
  27. associated files.  If you don't know how to do this, you should read
  28. through the owner's manual shipped with your Amiga before using QED, or any
  29. other program.
  30.  
  31. ======================================================================
  32.                               INSTALLATION
  33. ======================================================================
  34.  
  35.      QED is not copy protected, and can be easily copied to any floppy
  36. disk, or hard drive.  QED is a stand-alone program, and easily installed.
  37.  
  38. CLI USERS:
  39.  
  40.      It is recommended you copy QED to the C: directory.  QED may be
  41. renamed to something else if you prefer.
  42.  
  43. WORKBENCH USERS:
  44.  
  45.      Simply drag the QED icon to any Workbench drawer.
  46.  
  47.  
  48. ======================================================================
  49.                     STARTING QED FROM THE WORKBENCH
  50. ======================================================================
  51.  
  52.      As a reminder, "QED" the program is a Workbench TOOL while the files
  53. it creates are known as Workbench PROJECTS.  There are a number of ways to
  54. start QED from the Workbench including:
  55.  
  56.  
  57. Double click on the QED TOOL icon -
  58.  
  59.     QED will open a single untitled text editing window.
  60.  
  61.  
  62. Double click on a PROJECT icon created by QED -
  63.  
  64.     QED will open a single text editing window, and open the
  65.     PROJECT.
  66.  
  67.  
  68. Multiple select PROJECTS created by QED -
  69.  
  70.     QED will open one, or more text editing windows, and attempt to
  71.     automatically open each of the highlighted PROJECTS.  The PROJECTS may
  72.     exist may exist in different DRAWERS.  Up to sixteen (16) project
  73.     files can be automatically opened using multiple selection.
  74.  
  75.  
  76.      Finally it is highly recommended that you use the 1.3 'ram-handler' as
  77. the 1.2 RAM: disk handler is faulty.  It does not have a volume name, so
  78. QED may not be able to locate PROJECTS in the RAM disk.
  79.  
  80.  
  81. ======================================================================
  82.                          STARTING QED FROM THE CLI
  83. ======================================================================
  84.  
  85.  
  86.      QED can be started from the CLI like any other program.  It is assumed
  87. that the reader who uses the CLI is already familiar with how to run
  88. programs from the CLI.
  89.  
  90.      Up to sixteen (16) filenames may be entered as command line arguments. 
  91. In this case QED will attempt to automatically open each in a separate text
  92. editing window.  If no filename is specified, then a single untitled text
  93. editing window is opened.
  94.  
  95.      There are a number of startup switches that can be included on the
  96. command line along with a list of file names.  These switches are
  97. documented further on in this manual, and can be included on the command
  98. line along with the list of filenames in any order.
  99.  
  100.  
  101. ======================================================================
  102.                         MAKING QED RESIDENT
  103. ======================================================================
  104.  
  105.      If you are using the Amiga Shell, QED is fully reentrant which means
  106. it can be made RESIDENT, and run multiple times without having to reload
  107. QED.  As a reentrant program QED requires a moderate size stack of at least
  108. 10000 bytes.  A memory savings technique is used which allows subsequent
  109. resident QED processes to use less memory; all memory is returned to the
  110. system when the final resident QED process is quit.
  111.  
  112.      Note that as of this writing, ARP's ARES command doesn't believe that
  113. QED is fully reentrant.  This is a problem with ARP's definition of how a
  114. reentrant program should look, so no attempt has been made to convince ARP
  115. otherwise.
  116.  
  117.  
  118. ======================================================================
  119.                             STARTUP ERRORS
  120. ======================================================================
  121.  
  122.      QED may not be able to run for a number of reasons.  In this case QED
  123. returns an error code to the CLI, and displays an error message in the CLI
  124. window, or a temporary window if started from the Workbench:
  125.  
  126. Error #    Description                                      
  127.  
  128. 20         Stack too small (10000 minimum)
  129. 21         Need KickStart 1.2, or higher
  130. 22         Cannot use system font
  131. 23         Error opening console.device
  132. 24         Not enough memory
  133. 25         Port name already in use
  134. 26         Unable to create ARexx port
  135.  
  136.  
  137. ======================================================================
  138.                             STARTUP MACROS
  139. ======================================================================
  140.  
  141.  
  142.      When QED is started it will by default automatically attempt to
  143. execute a QED macro called "startup", and an ARexx macro called
  144. "startup.qed".  Specifics on writing startup macros will be discussed in a
  145. separate document. 
  146.  
  147.      In addition, it is worth mentioning now that you can write macros
  148. which will be automatically executed when a file is opened based on the
  149. filename's extension.
  150.  
  151.      These auto-executing macros allow you to configure QED to suit your
  152. default preferences, as well as customize each text editing window based on
  153. the kinds of files you are working with.
  154.  
  155.      The startup macros are optional.  If they are not found, or ARexx is
  156. not available, these features are ignored.
  157.  
  158.  
  159. ======================================================================
  160.                          STARTUP SWITCHES
  161. ======================================================================
  162.  
  163.      There are a number of startup switches which may be entered from the
  164. CLI, or included in QED's Workbench icon as 'tooltypes' which allow you to
  165. control QED's macro capabilities.
  166.  
  167.  
  168. OPENING A PUBLIC AREXX PORT
  169. ----------------------------------------------------------------------
  170.  
  171. CLI: -P[optional port name]          Workbench: PORT=[optional port name]
  172.  
  173.      This switch tells QED that you want it to open a public ARexx port. 
  174. The public ARexx port is not needed to run macros from within QED; just if
  175. you want to send commands to QED from another ARexx task.
  176.  
  177.      If the port name is omitted, then QED will create a unique port name
  178. for you such as "QED1", "QED2", "QED3", etc.  If you specify the port name,
  179. such as '-Pmyport', the name is converted to uppercase letters such as
  180. "MYPORT".
  181.  
  182.      The public ARexx port is by default assigned to the first text editing
  183. window opened, and clearly displayed in the window's title bar.
  184.  
  185.  
  186. RUNNING QED AS A HIDDEN BACKGROUND PROCESS
  187. ----------------------------------------------------------------------
  188.  
  189. CLI: -H[optional port name]          Workbench: HIDDEN=[optional port name]
  190.  
  191.      This switch is similar to the -P switch above, and is meant for
  192. advanced users only.  This command allows you to use QED as a hidden text
  193. editing engine by running QED as a hidden background process.
  194.  
  195.      You can send any commands to the ARexx port which you might usually
  196. use, however there is no visible screen activity, no pull-down menus, no
  197. keyboard editing, etc.  This is an excellent way to run well debugged
  198. macros, and in addition your macros may run faster as there is no window
  199. drawing to be done.
  200.  
  201.      You can open the command mode window as part of your startup macro,
  202. and enter commands in command mode.  When the -H switch is used, only one
  203. file can be automatically opened at startup.
  204.  
  205.  
  206. RUNNING AN ALTERNATIVE QED FORMAT STARTUP MACRO
  207. ----------------------------------------------------------------------
  208.  
  209. CLI: -Q[alternative macro]   Workbench: QED=[alternative macro]
  210.  
  211.      This switch allows you to override the default search for a QED macro
  212. called 'startup' in your QED: directory.  If the -Q switch is used alone,
  213. then no startup macro will be run.  If the startup macro is not found, QED
  214. just continues, and sets up using the built-in defaults.
  215.  
  216.      The QED startup macro is always run before the first text editing
  217. window is made visible, and is an excellent way to quickly set-up the
  218. options, colors, keyboard, etc. to suit your preferences.
  219.  
  220.  
  221. RUNNING AN ALTERNATIVE AREXX FORMAT STARTUP MACRO
  222. ----------------------------------------------------------------------
  223.  
  224. CLI: -S[alternative macro]   Workbench: STARTUP=[alternative macro]
  225.  
  226. This switch allows you to override the default search for an ARexx macro
  227. called 'startup.qed'.  If the -S switch is used alone, then no startup
  228. macro will be run.  If the startup macro is not found, QED just continues,
  229. and sets up using the built-in defaults.
  230.  
  231.  
  232. RUNNING THE AREXX STARTUP MACRO AFTER OPENING A TEXT EDITING WINDOW
  233. ----------------------------------------------------------------------
  234.  
  235. CLI: -A                      Workbench: AFTER
  236.  
  237. Normally QED attempts to run your ARexx startup macro before the first text
  238. editing window is made visible.  However there may be times when you want
  239. to run the ARexx startup macro after the first text editing window is
  240. opened (e.g., debugging your startup macro with ARexx's tracing abilities,
  241. or when running an automated sequences of events).  In this case use this
  242. flag to tell QED you want to run the ARexx startup macro AFTER the first
  243. text editing window is made visible.
  244.  
  245.  
  246. ======================================================================
  247.                      FONTS, KEYBOARD, SCREENS, ETC.
  248. ======================================================================
  249.  
  250.      When you start QED, one of the first things it does is take a look to
  251. see what kind of font you are using as your system font.  The pull-down
  252. menus, requesters, and windows are automatically adjusted to make use of
  253. your system font.
  254.  
  255.      The pull-down menus have been designed to fit on a 640x200 screen
  256. using a font as wide as Topaz 9, and as tall as Topaz 11.  QED will not run
  257. if you are using a proportional system font, or reverse path font; it is
  258. afterall a text editor, and not a desktop publishing program.  QED also
  259. will not run if your system font is too large; this can result in menus
  260. which when drawn are larger than the screen, and will trash memory outside
  261. of screen memory.
  262.  
  263.      Blitter based fast text rendering routines are built into the program.
  264. These routines make it possible for QED to redraw text at a very fast rate.
  265.  Eight bit wide fonts will be rendered the fastest, however these routines
  266. will speed up rendering of fonts of virtually any size.  Those running fast
  267. 68020, or 68030 based machines may wish to turn this feature off from the
  268. command mode as a fast processor can be faster then the Amiga blitter.
  269.  
  270.      Some fonts such as Courier.font can be used, though they are not
  271. true non-proportional fonts.  It turns out Courier.font is marked as a
  272. non-proportional font, which is not entirely true.
  273.  
  274.      The colors used by QED have been selected for visibility on a one bit
  275. plane screen, however support is provided for selecting preferred text
  276. rendering colors far beyond the capabilities provided by the current
  277. generation of Amiga hardware.
  278.  
  279.      QED also uses your system's keymap to decode the alpha-numeric keys on
  280. the keyboard, and dead-keys are supported for those using keymaps which
  281. utilize this capability.  Some keys such as the RETURN key, CURSOR keys,
  282. TAB key, etc., are intercepted by QED, and are not decoded using your
  283. system's keymap (these keys can be remapped using QED commands).
  284.  
  285.      Text editing windows may be opened to the full size of your Workbench
  286. screen; overscan screens, NTSC or PAL displays, and the high res Moniterm
  287. monitor, or 2024 monitor can be utilized by QED.
  288.  
  289.  
  290. ***NOTE***
  291.  
  292. QED's font handling routines have been fully tested with Preferences,
  293. SetFont from David Haynie, and FastFonts from MicroSmiths Inc.  FastFonts
  294. is being distributed with Workbench 1.3, and supports the ability to modify
  295. your system font.
  296.  
  297. When running under version 2.0 of the operating system, QED uses your
  298. default screen font, which is the same font used by CLI windows to render
  299. text.
  300.  
  301.  
  302.